home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games 1996 July / Amiga Games 1996 #7.iso / userbox / publicdomain / mwm / docs / mwm_eng.doc < prev    next >
Encoding:
Text File  |  1996-04-04  |  23.0 KB  |  686 lines
  1.  
  2. Version 1.01
  3.  
  4.  
  5.       +--- -  -                 -  - ---+--- -  -                -  -  ---+
  6.  
  7.       |   ! Welcome to the first very easy-to-use HTML file generator !   |
  8.  
  9.       +--- -  -                 -  - ---+--- -  -                -  -  ---+
  10.  
  11.  
  12.                       __   __   __             __   __   __
  13.                      /  \_/  \  \ \           / /  /  \_/  \
  14.                     / /\   /\ \  \ \    _    / /  / /\   /\ \
  15.                    / /  \_/  \ \  \ \  / \  / /  / /  \_/  \ \
  16.                   / /         \ \  \ \/ _ \/ /  / /         \ \
  17.                  /_/           \_\  \__/ \__/  /_/           \_\
  18.  
  19.                -->*  Magic WWW  (World-Wide Web) files Maker  *<--
  20.                      _______________________________________
  21.                                         |
  22.                                         |
  23.                                        \|/
  24.                                         X
  25.                        ___________________________________
  26.                       |                                   |
  27.                       | from an idea of  Maurizio Fabiani |
  28.                       |    developed by  Massimo Baglione |
  29.                       |___________________________________|
  30.  
  31.  
  32. 0> FIRST
  33.  
  34.     Please, excuse my painful english! (;-))
  35.  
  36.  
  37. 1> INTRODUCTION
  38.  
  39.  One day my friend Maurizio ask to me: "Hey Max, do you think that can be possible
  40.     to write a program to create files in HTML format just loading a simple ASCII text
  41.     and handle it with the mouse to define the final HTML file ?"
  42.  
  43.  I said: "Oh my God! Miracles are not my speciality!"... but he won!
  44.  
  45.  Well, the final result is near.
  46.  
  47.  MWM, infact, allows you to load a normal text file and by the mouse is possible to attach
  48.     images, texts, lists and many other HTML object to the selected lines and/or words.
  49.  
  50.  The GUI is essentially composed by:
  51.  
  52.     - Main window, that will show the normal loaded text file.
  53.       If a part of text is defined by an action, then it will be highlighted with a different
  54.       color from the rest of the text.
  55.       Like some word processors, this window contains a lot of small graphic gadgets linked
  56.       to different actions.
  57.  
  58.     - Single Line window:
  59.  
  60.     - Labels window, that will show all labels included in a file HTML to be linked.
  61.       (see later).
  62.  
  63.     - Help window (or Log window).
  64.  
  65.     - "What is ?" window.
  66.  
  67.  
  68. 2> MAIN WINDOW
  69.  
  70.  Once loaded a simple text file, you can see it into the Main Window.
  71.  
  72.  With the left mouse button you can select a part of the text and with one of the
  73.     instruments gadgets can be possible to attach an action to it like lists, texts,
  74.     images, hyperlinks and many other stuffs permitted by the HTML 3.0 specs.
  75.  
  76.  If you need to attach an action to a single word into a line, it's sufficient a
  77.     double-click on this line.
  78.  
  79.  The Single Line window will appear with your desired line.
  80.  
  81.  Any action will create an object that will be showed on the Main Window with different
  82.     colors.
  83.  
  84.  Any created object will be numbered in order of creation and by selecting it it's
  85.     possible to check the essential data into the Log Window.
  86.  
  87.  If text is greater the the window, you can scroll it by pressing arrows keys or using
  88.     the scroll gadgets.
  89.  
  90.  
  91.  Starting from the first gadget on the left, we have:
  92.  
  93.  
  94.     - First gadget  (TEXT)
  95.  
  96.         This action will define for selected lines a particular type of text.
  97.  
  98.         If you are working on the Single Line window, MWM will show the following choices:
  99.  
  100.             - It's a link to an already defined label into the current document.
  101.  
  102.             - It's a link to an other document.
  103.  
  104.                 In this case a program like Mosaic will highlight this part of text
  105.                 and, if the user click on this object, than a new text defined by this
  106.                 action will called.
  107.  
  108.                 After choosing the file to be linked, MWM will ask you if you need to
  109.                 refer to a label into the linked text.
  110.                 If yes, a listview will show a complete list of its labels.
  111.                 Just do a doubble-click to make the choice.
  112.  
  113.             - It's a link to a site.
  114.  
  115.                 MWM will show a requester to know where it can go to read the site name.
  116.  
  117.                 You can choose from:
  118.  
  119.                     - Selected line.
  120.  
  121.                         The site name is the current selected text.
  122.                         In this case MWM will reduce to one all selected lines.
  123.  
  124.                     - Keyboard.
  125.  
  126.                         The site name will be defined manually by the keyboard.
  127.  
  128.                     - PATH:file.
  129.  
  130.                         The site name is specified into the previously defined file name
  131.                         defining the configuration.
  132.  
  133.                         MWM will give you the following list:
  134.  
  135.                             file://localhost/
  136.                             http://
  137.                             ftp://
  138.                             mailto:
  139.                             news:
  140.                             gopher:
  141.                             telnet:
  142.  
  143.                         Onse choosed, you must add the complete name of the site.
  144.  
  145.                         If not previously defined, MWM will find the sites list
  146.                         into the file:
  147.  
  148.                             "PROGDIR:MWM.sites".
  149.  
  150.                         The list MUST look like that:
  151.  
  152.                             maui@mbox.vol.it
  153.                             mwm@the.best.world
  154.                             you@example.any.ok
  155.                             ...
  156.  
  157.                         It's possible to define a different location for that file
  158.                         using the "Preferences" menu function.
  159.  
  160.  
  161.             - It's a simple text.
  162.  
  163.         Otherwise, if you are working on the Main Window with one or more selected lines,
  164.         MWM will expand the previous choices with the following:
  165.  
  166.             - It's a preformatted text.
  167.  
  168.             - It's a paragraph.
  169.  
  170.                 Selected lines will be incleded between <P> and </P>.
  171.                 MWM will ask you an allineament: DEFAULT, LEFT, RIGHT, JUSTIFY.
  172.  
  173.             - It's an information about you.
  174.  
  175.                 Selected lines will be incleded between <ADDRESS> and </ADDRESS>.
  176.  
  177.  
  178.     - Second gadget  (IMAGE)
  179.  
  180.         This action will _REPLACE_ selected text with an image.
  181.  
  182.         A file requester will be opened to you to select the image file.
  183.         After this, MWM will ask you what type of image you desire:
  184.  
  185.             - It's a link to an already defined label into the current document.
  186.  
  187.             - It's a link to an other document.
  188.  
  189.                 In this case a program like Mosaic will highlight this part of text
  190.                 and, if the user click on this object, than a new text defined by this
  191.                 action will called.
  192.  
  193.                 After choosing the file to be linked and the alignement type for this image,
  194.                 MWM will ask you if you need to refer to a label into the linked text.
  195.                 If yes, a listview will show a complete list of its labels.
  196.                 Just do a doubble-click to make the choice.
  197.  
  198.             - It's a link to a site.  (See above on the TEXT part)
  199.  
  200.             - It's a MAP image.
  201.  
  202.             - It's a simple image.
  203.  
  204.         The following are a list of possible alignement for an image:
  205.  
  206.                 - BOTTOM
  207.                 - MIDDLE
  208.                 - TOP
  209.  
  210.  
  211.     - Third gadget  (LIST)
  212.  
  213.         This action will define selected lines as a list.
  214.  
  215.         There are three types of lists:
  216.  
  217.             - Unnumbered, for example:
  218.  
  219.                 * it's cold
  220.                 * it's warm
  221.                 * it's rain
  222.  
  223.             - Numbered, for example:
  224.  
  225.                 1- Don't drink if you must drive
  226.                 2- Don't drive if you have drunk
  227.                 3- Cappuccino is more greedy than beer
  228.                 4- Milk is finish, give my a beer!
  229.  
  230.             - Definition, for example:
  231.  
  232.                 Colors
  233.  
  234.                     Red
  235.                     Green
  236.                     Blue
  237.  
  238.                 Planetarium
  239.  
  240.                     Mercury
  241.                     Mars
  242.                     Jupiter
  243.                     Earth
  244.                     ...
  245.  
  246.         After choosing the right type, MWM will ask you if you want to add more infos
  247.             to every element of the list.
  248.  
  249.         If not, the list will become a simple list of words.
  250.         If yes, MWM will show you line by line the selected text asking you what
  251.             you want to define:
  252.  
  253.             - It's a link to an already defined label into the current document.
  254.  
  255.             - It's a link to an other document. (See TEXT and IMAGE)
  256.  
  257.             - It's a link to a site.  (See above on the TEXT part)
  258.  
  259.             - It's a simple text.
  260.  
  261.  
  262.     - Fourth gadget  (FORM)
  263.  
  264.         This action is composed by two steps:
  265.  
  266.         The first step:
  267.             where you define the part of the text that will become the FORM.
  268.             MWM will ask you the type: the possible responses are GET, POST and Cancel.
  269.  
  270.             After this, MWM needs to know the Action (like URL).
  271.             This is an example of Action: "http://x/y/sample".
  272.  
  273.             Now you can see that the color of selected text is changed.
  274.             How you can see, only in FORM object is possible to select one or more
  275.             lines into.
  276.  
  277.         The second step:
  278.             only now it's possible to define all other stuffs of the FORM.
  279.             You have the following possibilities:
  280.  
  281.             - It's a simple text
  282.                 Useful to describe some other more important objects.
  283.  
  284.             - It's an INPUT
  285.                 This choice will open a requester with the following type of input:
  286.  
  287.                     1> Text                     7> file
  288.                     2> Password                 8> Hidden
  289.                     3> Checkbox                 9> Submit
  290.                     4> Radio                   10> Image
  291.                     5> Range                   11> Reset
  292.                     6> Scribble
  293.  
  294.                 If you choose the number 4 (RADIO), MWM will check if selected lines
  295.                 are more than one.
  296.                 In that case, MWM will ask you if you want to include these into the
  297.                 same RADIO group.
  298.  
  299.                 If yes, the RADIO group will have the same field name.
  300.                 In this way, a program like Mosaic can be sure that one and only one of
  301.                 it can be selected by the user.
  302.  
  303.             - It's a list of INPUTs
  304.  
  305.                 Don't work if you are working on the single line window.
  306.  
  307.                 Any single INPUTs to define will be included in a list.
  308.  
  309.         Every element of the FORM (except that inserted in a list) will be saved into
  310.             the final HTML file prefixed by the <P> string just to separate
  311.             one line from another one.
  312.  
  313.         If you needs to insert two or more element of the FORM into the same line, it's
  314.             possible to do a double-click on it using the Single Line window.
  315.  
  316.  
  317.     - Fifth gadget  (MORE)
  318.  
  319.         This action changes if you are working on the Main Window or on the Single Line
  320.             window.
  321.  
  322.         In the first case:
  323.  
  324.             if selected text are uninitialized (in other words without objects),
  325.             MWM will reduce to one all selected lines asking you what you want to do with
  326.             this line.
  327.  
  328.             These are the possibilities:
  329.  
  330.                 - Insert label here                 (<ID>) for hyperlinks;
  331.                 - Insert comment here               (<!-- -->);
  332.                 - Define title for current document (<TITLE>).
  333.                 - Define the background image       (<BODY BACKGROUND>).
  334.                 - Insert empty line.                (<P>)
  335.                 - Insert horizontal graphic line    (<HR>).
  336.  
  337.             Otherwise, if selected text are initialized, MWM will expand the previous
  338.             questions with the following:
  339.  
  340.                 - Citation (Typically in italic).   (CITE)
  341.                 - Emphasis                          (EM)
  342.                 - Strong emphasis                   (STRONG)
  343.                 - Code                              (CODE)
  344.                   Look like preformatted text, for example: 1 + 1 = 2.
  345.                 - Author                            (AU)
  346.                   For an author of a book etc...
  347.                 - Person                            (PERSON)
  348.                   For a generic person name.
  349.                 - Sequence of chars.                (SAMP)
  350.                 - Keyboarded text.                  (KBD)
  351.                 - Variable name.                    (VAR)
  352.                 - Definition.                       (DFN)
  353.                 - Short quote.                      (Q)
  354.                 - Acronyms.                         (ACRONYM)
  355.                 - Abbreviations.                    (ABBREV)
  356.                 - Inserted text.                    (INS)
  357.                 - Deleted text.                     (DEL)
  358.                 - Bold text.                        (B)
  359.                 - Italic text.                      (I)
  360.                 - Typewriter text.                  (TT)
  361.                 - Underscored text.                 (U)
  362.                 - "Lined" text.                     (S)
  363.                 - Big text.                         (BIG)
  364.                 - Small text.                       (SMALL)
  365.                 - To understand (;-)).              (SUB)
  366.                 - To anderstand (;-))               (SUP)
  367.  
  368.             If selected lines are part of the HEAD, than a different requester will be
  369.             showed to you with:
  370.  
  371.                 - Attach a BANNER
  372.                   With this action you can choose an HTML file to be a fixed banner.
  373.  
  374.                         ex:  <LINK REL=Banner HREF=mypath:mybanner.HTML>
  375.  
  376.         In the second case:
  377.             this action will work if into the Single Line window there is a created
  378.             and selected object.
  379.  
  380.             If selected object is a text, MWM will show you these choices:
  381.  
  382.                 - Citation (Typically in italic).   (CITE)
  383.                 - Emphasis                          (EM)
  384.                 - Strong emphasis                   (STRONG)
  385.                 - Code                              (CODE)
  386.                   Look like preformatted text, for example: 1 + 1 = 2.
  387.                 - Author                            (AU)
  388.                   For an author of a book etc...
  389.                 - Person                            (PERSON)
  390.                   For a generic person name.
  391.                 - Sequence of chars.                (SAMP)
  392.                 - Keyboarded text.                  (KBD)
  393.                 - Variable name.                    (VAR)
  394.                 - Definition.                       (DFN)
  395.                 - Short quote.                      (Q)
  396.                 - Acronyms.                         (ACRONYM)
  397.                 - Abbreviations.                    (ABBREV)
  398.                 - Inserted text.                    (INS)
  399.                 - Deleted text.                     (DEL)
  400.                 - Bold text.                        (B)
  401.                 - Italic text.                      (I)
  402.                 - Typewriter text.                  (TT)
  403.                 - Underscored text.                 (U)
  404.                 - "Lined" text.                     (S)
  405.                 - Big text.                         (BIG)
  406.                 - Small text.                       (SMALL)
  407.                 - To understand (;-)).              (SUB)
  408.                 - To anderstand (;-))               (SUP)
  409.  
  410.  
  411.     - Sixth gadget  (HEAD)
  412.  
  413.         This action will define selected lines as HEAD.
  414.  
  415.         Into the HEAD are essentially defined the TITLE of the document, some others
  416.             informations and the selected text.
  417.  
  418.         By using MORE action you can insert a banner.
  419.  
  420.  
  421.     - Seventh gadget  (SIZE)
  422.  
  423.         With this action you can modify the font size of the selected lines.
  424.         The following are the possible choices:
  425.  
  426.             - <H1> Very large font, bold.
  427.             - <H2> Large font, bold.
  428.             - <H3> Large font, italic..
  429.             - <H4> Normal font, bold.
  430.             - <H5> Normal font, italic.
  431.             - <H6> Small font.
  432.  
  433.         Note that these values are just an indication.
  434.  
  435.         When loading a simple text, MWM set this value to <H5> to every lines.
  436.         Use the "HTML defaults" into the "Preferences" menu to change this default.
  437.  
  438.         Onse choosed, you can select an alignement:
  439.  
  440.             - LEFT (default)
  441.             - CENTER
  442.             - LEFT
  443.             - JUSTIFY
  444.  
  445.  
  446.     - Eighth gadget  (VIEW)
  447.  
  448.         This action allows you to call a program like Mosaic to see at any time
  449.             the final work.
  450.  
  451.  
  452. 3> "What is ?" WINDOW
  453.  
  454.  You can see this window on the left of the Main Window.
  455.  
  456.  Example:
  457.  
  458.     *-----------**----------------------------------*
  459.     | What is ? || MWM Edit Window                  |
  460.     ------------- -----------------------------------
  461.     | ........  || Uninitialized text               |
  462.     | Text Hn X || Initialized Text                 |
  463.     | Head      || Text of the <HEAD> block         |
  464.     | Form ABC_1|| Text of the <FORM> block         |
  465.     | Preformat || Preformatted text <PRE>          |
  466.     | Address   || Text of the <ADDRESS> block      |
  467.     | Paragraph || Paragraph text <P>               |
  468.     | List XL   || Text of the <LIST> block         |
  469.     | Image     || Text that will be an image       |
  470.     | To site   || Hyperlink to a site              |
  471.     | Multi obj || Text including more objects      |
  472.     | Label     || There are a label <ID>           |
  473.     | Comment   || There are a comment  <!-- ... -->|
  474.     | Lab & Com || There are both label and comment |
  475.     |___________||__________________________________|
  476.  
  477.     Description:
  478.  
  479.         Hn = Heading <H1> to <H6>, <HD> for default value.
  480.  
  481.          X = Allignement: L = LEFT  C = CENTER  R = RIGHT  J = JUSTIFY
  482.  
  483.         XL = List type: UL = Unnumbered  OL = Numbered  DL = Definition
  484.  
  485.      ABC_1 = Form method: Get or Post.
  486.  
  487.  
  488. 4> THE MENU
  489.  
  490.     Into the main window you can use a menu with the following items:
  491.  
  492.         * Project
  493.  
  494.             - Load text
  495.  
  496.                 Allows to load a normal ASCII text file.
  497.  
  498.                 If a text was already loaded, MWM will ask if you want to delete it
  499.                     or to attach the new to the old.
  500.  
  501.                 In the first case, MWM will ask the insertion type:
  502.  
  503.                     - To the beginning;
  504.                     - To the end;
  505.                     - From the first selected line.
  506.  
  507.             - Save html
  508.  
  509.                 Allows you to save the work creating the desired HTML file.
  510.  
  511.                 MWM needs to know if you want to save also all uninitialized text or not.
  512.  
  513.                 If not, than only created objects, labels and comments will be included
  514.                     into the HTML file.
  515.  
  516.                 Else, if yes, all uninitialized text will be saved as simple text and
  517.                     the string <BR> will be added to the end of each line of it.
  518.  
  519.                 After this MWM will check for title and, if not exists, a requester will
  520.                     help you.
  521.  
  522.             - Load saved work
  523.  
  524.                 Load a previously saved work.
  525.  
  526.             - Save work
  527.  
  528.                 Save the entire work in a file to be recalled at any time to continue
  529.                 the development of it.
  530.  
  531.             - About.
  532.  
  533.                 The MWM's brain and arm! (;-))
  534.  
  535.             - Quit
  536.  
  537.                 End of work.
  538.  
  539.         * Edit
  540.  
  541.             - Cut
  542.  
  543.                 This action kill completely all selected lines or only the created infos
  544.  
  545.             - Search new
  546.  
  547.                 Search a new string.
  548.  
  549.             - Search again.
  550.  
  551.                 Search the same string.
  552.  
  553.             - Edit selected lines
  554.  
  555.                 This action allows you to modify the selected text.
  556.                 The previously created objects will NOT touched.
  557.  
  558.         * Action
  559.  
  560.             - Text  \
  561.             - Image  \
  562.             - List    \
  563.             - Form     \___\  Same functions of the gadgets into the main window.
  564.             - More     /   /
  565.             - Head    /
  566.             - Size  /
  567.             - Viev  /
  568.  
  569.         * Preferences
  570.  
  571.             - Texts path
  572.  
  573.                 To define a common path for all texts.
  574.  
  575.             - Images path
  576.  
  577.                 To define a common path for all images.
  578.  
  579.             - Work dir
  580.  
  581.                 To define your favourite working directory (ex: RAM:t).
  582.  
  583.             - Browser
  584.  
  585.                 To choose the preview program, for example AMosaic or IBrowse.
  586.  
  587.             - Sites list
  588.  
  589.                 To choose the file containing the list of sites.
  590.  
  591.             - Screen prefs
  592.  
  593.                 To change the graphic mode for MWM screen.
  594.                 I like CUSTOM mode.
  595.  
  596.             - Select new font
  597.  
  598.                 Change the current font in main window.
  599.  
  600.             - Edit log window
  601.  
  602.                 Allows you to personalize the Log Window.
  603.  
  604.             - HTML defaults
  605.  
  606.                 To personalize some defaults on the final HTML file.
  607.  
  608.                 In this version, this action will open the following requester:
  609.  
  610.                     - Heading size;
  611.  
  612.                         The MWM's default for headings is H5 and all uninitialized
  613.                         text will be saved as H5.
  614.  
  615.                         If you want a different heading size, just select one of
  616.  
  617.                                     H1 H2 H3 H4 H5 H6
  618.  
  619.                         into the listview.
  620.  
  621.             - All
  622.  
  623.                 To define all the previous at the same time.
  624.  
  625.         When done, MWM will ask you if you want to save the preferences file
  626.             "MWM.prefs" into ENV: and ENVARC:.
  627.  
  628.  
  629.  - GENERAL INFORMATIONS
  630.  
  631.     MWM needs OS 3.0 or greater.
  632.  
  633.     This program was constructed following the HTML specs included into the archive
  634.     HTML30GU.LHA findable in any BBS and in aminet.
  635.  
  636.     This version is absolutely Copyright!
  637.  
  638.     If you like this program and you need all disabled function, you can send me
  639.     25 US dollars to the following address:
  640.  
  641.                 Massimo Baglione
  642.                 Via Acqua Fredda (Marrone int. 9)
  643.                 67040  Rocca S. Stefano
  644.                        Tornimparte  L' AQUILA  (Italy)
  645.  
  646.     specifying where I can send the KEY disk.
  647.  
  648.     For any suggestion, idea or mail bombs, please contact more fast as possible:
  649.  
  650.                 Massimo Baglione            Maurizio Fabiani
  651.                                             (MAUI for Amiga BBS)
  652.  
  653.                       39:102/1.5  AmigaNet  39:102/1
  654.                       39:102/2.5            39:102/2
  655.  
  656.                      2:335/602.5  FidoNet   2:335/602
  657.                      2:335/607.5            2:335/607
  658.  
  659.                                   InterNet
  660.  
  661.                    (Maurizio Fabiani)  maui@mbox.vol.it
  662.  
  663.  
  664.  - GREATINGS
  665.  
  666.     I must thanks all my betatesters for their good bug report about MWM.
  667.     In particular, I want to quote (in alphabetical order):
  668.  
  669.         Troy Bouchar  (Snowy Hill)
  670.         Mel  Greer
  671.         for their incredible minds!
  672.  
  673.         Ross Delaforce
  674.         for his FTP support
  675.  
  676.     More, a big kiss (!) is flying to my Boss (Maurizio Fabiani) for its
  677.     neverending patience!
  678.  
  679.     The last greating is reserved to Amiga: (all together) ...THANKS AMIGA!!!
  680.  
  681.                             -----+-----
  682.  
  683.       -=> * \X/ Amiga!  \X/ MAUI BBS!  \X/ Love and Beer! * <=-
  684.  
  685. ...enjoy this program!!!
  686.